home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbsdoors / ckit258.zip / CKIT.H < prev    next >
C/C++ Source or Header  |  1993-06-01  |  22KB  |  363 lines
  1. /****************************************************************************
  2.  *   FILE CKIT.H                                                            *
  3.  *   Created 11-FEB-1990            Rickie W. Belitz                        *
  4.  *                                  820 Brentwood Drive                     *
  5.  *                                  Maryville, Tennessee  37801             *
  6.  *                                  BBS (615) 690-8231                      *
  7.  *                                      (615) 690-7968                      *
  8.  *                                      (615) 690-7913                      *
  9.  *                                                                          *
  10.  *   Include file for    CKIT - DOOR Toolkit v2.58                          *
  11.  *   Modifications for better C++ compatiblity with MSC++ and BC++          *
  12.  *                                                                          *
  13.  ****************************************************************************/
  14. /******************************************************************************
  15. *                        INCLUDE files needed                                 *
  16. *******************************************************************************/
  17. #if     !defined(__CKIT_H)
  18. #define __CKIT_H
  19.  
  20. #include    <stdio.h>
  21. #include    <stdlib.h>
  22. #include    <dos.h>
  23. #include    <time.h>
  24. #include    <string.h>
  25. #include    <stdarg.h>
  26. #include    <share.h>
  27. #include    <io.h>
  28. #define     MICROSOFT   1
  29. #define     TURBOC      2
  30. /****************************************************************************
  31.  *      IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF         *
  32.  ****************************************************************************/
  33. #if COMPILER == MICROSOFT
  34.     #include    <malloc.h>
  35. #else
  36.     #if COMPILER == TURBOC
  37.         #include    <alloc.h>
  38.     #endif
  39. #endif
  40.  
  41. /****************************************************************************
  42.  *     ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF    *
  43.  ****************************************************************************/
  44.  
  45. /* data type definitions */
  46. typedef     unsigned char BYTE;    /* Define BYTE to mean unsigned char */
  47.  
  48. /* logical  constants  */
  49. #define     ERR         -1
  50. #define     EVER        ;;         /* Used in "for (EVER)"              */
  51. #define     FALSE       0
  52. #define     TRUE        1
  53. #define     NOT_READY   -1
  54. #define     NO_KEY      0
  55. #define     EXITDOOR    0           /* User exited Door     */
  56. #define     NOCARRIER   1           /* Carrier lost         */
  57. #define     TIMEOUT     2           /* Keyboard timeout     */
  58. #define     SYSOP_O     3           /* Sysop request        */
  59. #define     SYSTEMTIME  4           /* System time elapse   */
  60. #define     LOGOFF      5           /* Normal logoff        */
  61. /******************************************************************************
  62. *                        ANSI color table indexes                             *
  63. *******************************************************************************/
  64. #define dkblue          1
  65. #define dkgreen         2
  66. #define dkcyan          3
  67. #define dkred           4
  68. #define dkviolet        5
  69. #define magenta         5
  70. #define brown           6
  71. #define grey            7
  72. #define dkgrey          8
  73. #define blue            9
  74. #define green           10
  75. #define cyan            11
  76. #define red             12
  77. #define violet          13
  78. #define yellow          14
  79. #define white           15
  80.  
  81.  
  82. /******************************************************************************
  83.  *        External variable declarations                                      *
  84.  ******************************************************************************/
  85. extern  BYTE    ck_option;             /* Defines how the user was logged off */
  86. extern  int     ck_DUMP_USER;          /* Set to log off user from door       */
  87. extern  BYTE    ck_DOTS;               /* Echo dots with input()              */
  88.  
  89. extern  char    ck_system_time_HHMMSS[];       /* System time                   */
  90. extern  char    ck_todays_date_MMDDYY[];       /* System date                   */
  91. extern  BYTE    ck_cmdline[];                  /* Used to hold user input       */
  92. extern  char    ck_par[];                      /* Used to parse next cmd to     */
  93. extern  short   ck_linenum;                    /* Number of lines displayed     */
  94. extern  short   ck_graphics;                   /* ANSI in use                   */
  95. extern  short   ck_display;                    /* Local display on/off          */
  96. extern  short   ck_local;                      /* Local mode indicator          */
  97. extern  short   ck_printer;                    /* Printer online/offline        */
  98. extern  short   ck_pagebell;                   /* Page bell on/off              */
  99. extern  short   ck_callalarm;                  /* Caller alarm on/off           */
  100. extern  short   ck_port;                       /* Port number in use            */
  101. extern  short   ck_error_connection;           /* Error correction modem?       */
  102. extern  short   ck_scan_code;                  /* Keycodes for non-standard key */
  103.                                             /* F1 - F10, arrow keys etc      */
  104.                                             /* Holds received all keycodes   */
  105.  
  106. /* misc. see CKIT.DOC for more information on these */
  107. extern  short   ck_time_on, ck_prev_used, ck_time_limit, ck_dload_limit,
  108.                 ck_time_added, ck_time_credit, ck_min_left,ck_event_active,
  109.                 ck_event_slide,ck_user_record, ck_ansi_ng, ck_record_lock,
  110.                 ck_PCB12, ck_PCB, ck_WILDCAT, ck_GENERIC,ck_GAP, ck_RBBS,
  111.                 ck_expert, ck_parity, ck_current_conf, ck_chatmode,
  112.                 ck_uart_base, ck_irq, ck_non_ibm, ck_FOSSIL, ck_silent,
  113.                 ck_NO_FKEYS, ck_NO_STATUS, ck_key_source, ck_Digiboard;
  114.  
  115.  
  116.  
  117.  
  118. extern  long    ck_mem_msg;             /* Mem. msg number, PCB 14.x       */
  119. extern  short   ck_time_credit_old;     /* PCB  14.x                       */
  120.  
  121. /* Info specific to PC14.5A users */
  122. extern  BYTE    ck_exited_DOS, ck_event_coming_up, ck_disable_uploads;
  123. extern  short   ck_last_event_mins, ck_last_conf;
  124. extern  char    ck_last_event_date[9];     /* MM-DD-YY                 */
  125.  
  126.  
  127. /* C strings containing information read from BBS system files  */
  128. extern  BYTE    ck_firstname[16];
  129. extern  BYTE    ck_fullname[26];
  130. extern  BYTE    ck_bps_open[6];
  131. extern  BYTE    ck_baud_rate[6];
  132. extern  BYTE    ck_sysop_next[2];
  133. extern  BYTE    ck_netchat[2];
  134. extern  BYTE    ck_password[13];
  135. extern  BYTE    ck_language[6];
  136. extern  BYTE    ck_event_time[6];
  137. extern  BYTE    ck_aport[2];
  138. extern  BYTE    ck_BBSname[63];
  139.  
  140. extern  char    ck_node[6];
  141.  
  142. extern  char    ck_upload_total[5];        /* Total files downloaded   */
  143. extern  char    ck_dload_total[5];         /* Total files uploaded     */
  144. extern  char    ck_daily_bytes[4];         /* Total Daily K bytes      */
  145. extern  char    ck_download_Kbytes[10];    /* Total K bytes downloaded */
  146. extern  char    ck_upload_Kbytes[10];      /* Total K bytes uploaded   */
  147. extern  BYTE    ck_time_logged[6];
  148. extern  char    ck_caller_bday[8];         /* Caller's birthday        */
  149. extern  char    ck_main_dir[80];           /* Main bbs system path     */
  150. extern  char    ck_gen_dir[80];            /* BBS system general path  */
  151. extern  char    ck_sysop_name[15];         /* Sysop first name         */
  152. extern  char    ck_sysop_alias[15];        /* Sysop's alias name       */
  153. extern  char    ck_last_file_scan[8];      /* Last new file scan       */
  154. extern  char    ck_max_files[4];           /* Max files allowed to dl  */
  155. extern  char    ck_daily_files[4];         /* Number of files today    */
  156. extern  char    ck_total_doors[4];         /* Total doors opened       */
  157. extern  char    ck_msgs_left[4];           /* Number of messages left  */
  158. extern  BYTE    ck_page_length;            /* User page length         */
  159. extern  char    ck_protocol[15];           /* User's default protocol  */
  160. extern  char    ck_security_level[5];      /* User's security level    */
  161. extern  char    ck_min_remaining[6];       /* mins left (door.sys)     */
  162. extern  char    ck_sec_remaining[6];       /* secs left (door.sys)     */
  163. extern  char    ck_default_color[2];       /* (door.sys)               */
  164. extern  char    ck_last_called[6];         /* (door.sys)               */
  165.                                               
  166. /* Below is info specific to WILDCAT! users */
  167. extern  char    ck_monitor_type[5]; /* MONO/COLOR (Graphics On/Off)        */
  168. extern  char    ck_max_sec[5];      /* Maximum security allowed             */
  169. extern  char    ck_high_msg[10];    /* High message number read             */
  170. extern  BYTE    ck_name_in_use;     /* True/False Name in use on other node */
  171. extern  char    ck_door_opened[5];  /* Door user opened                     */
  172.  
  173.  
  174. /* Below is info you will need to define in your door program */
  175. extern  short   ck_FORCEOFFHOOK;       /* Set to TRUE or FALSE                */
  176. extern  short   ck_LOGOFFMSG;          /* Set to TRUE or FALSE                */
  177. extern  short   ck_USERSFILE;          /* Set true if you want user file info */
  178.                                        /* PCBoard systems only                */
  179. extern  char    ck_progname[21];       /* Put you program name here.  define  */
  180.                                        /* the string in YOUR program          */
  181.                                        /* MAX. 20 chars. See CKITDEMO.H       */
  182.                                        /* for example                         */
  183. extern  char    ck_error_msg11[40];    /* Display file error msg, if you want */
  184.                                        /* to change it...MAX 40 chars!        */
  185. extern  short   ck_logoff_color;     /* Log off message color                 */
  186. extern  BYTE    *ck_conferences;     /* pointer to conferences registered in  */
  187. extern  BYTE    *ck_pcbsysbuf;       /* pointer to buffer holding pcboard.sys */
  188. extern  char    **ck_logoff_msgs;    /* pointer to log off messages           */
  189. extern  char    **ck_gen_msgs;       /* pointer to general internal messages  */
  190.  
  191.  
  192. /******************************************************************************
  193.  *                    Structure declarations (PCBoard 14.5 only)              *
  194.  ******************************************************************************/
  195. struct pcbuserstype {
  196.     char    name[26];                   /* First and Last name                */
  197.     char    city[25];                   /* City and State                     */
  198.     char    pwrd[13];                   /* Password                           */
  199.     char    bphone[14];                 /* Business/Data phone number         */
  200.     char    phone[14];                  /* Home phone number                  */
  201.     char    last_date[7];               /* Last date on in (YYMMDD) format    */
  202.     char    last_time[6];               /* Last logon time in HH:MM) format   */
  203.     char    expert[2];                  /* Expert Mode (Y or N)               */
  204.     char    protocol[2];                /* Protocol type                      */
  205.     BYTE    packed_byte;                /* Bit packed flags                   */
  206.     char    filedate[7];                /* Last DIR look date (YYMMDD) format */
  207.     BYTE    security;                   /* Security level of user             */
  208.     short   total_calls;                /* Number of times on                 */
  209.     BYTE    page_length;                /* Page length                        */
  210.     short   uploads;                    /* Number of Uploads                  */
  211.     short   downloads;                  /* Number of Downloads                */
  212.     double  dload_bytes;                /* Daily dload bytes so far           */
  213.     char    comment1[31];               /* User maintained comment            */
  214.     char    comment2[31];               /* Sysop maintained comment           */
  215.     short   time_used;                  /* Elapsed time on system             */
  216.     char    expire_date[7];             /* Subscription Reg. Date (YYMMDD)    */
  217.     BYTE    expire_level;               /* Expired security level             */
  218.     BYTE    current_conf;               /* Area number last in                */
  219.     BYTE    conferences[6];             /* Conferences area allowed in        */
  220.     BYTE    expire_conf[6];             /* Expired conference areas           */
  221.     BYTE    scan_conf[6];               /* Conferences desired for mail scan  */
  222.     double  dload_total;                /* Total bytes downloaded - all calls */
  223.     double  upload_total;               /* Total bytes uploaded - all calls   */
  224.     char    delete_user[2];             /* Delete user flag (Y or N)          */
  225.     unsigned long last_msg_read;        /* Last read msg Main area (default)  */
  226.     long    last_read[39];              /* Last Read Message Area pointers    */
  227.     BYTE    space2[15];                 /* Reserved                           */
  228. } extern ck_user;
  229.  
  230. /******************************************************************************
  231.  *   Structure to use with CKIT for BBS's not supported by CKIT               *
  232.  ******************************************************************************/
  233. struct ckitgeneric {
  234.     char port[6];                   /* COM:?  */
  235.     short min_left;                 /* minutes left */
  236. };                                  /* Name this what you want */
  237. extern  short  ck_NOSYSTEM;         /* Set true if want C-kit open_door()  */
  238.                                     /* to obtain information from ck_gen   */
  239.                                     /* ckitgeneric structure               */
  240. /****************************************************************************
  241.  *      IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF         *
  242.  ****************************************************************************/
  243. #ifdef __cplusplus
  244. extern "C" {
  245. #endif
  246.  
  247. /******************************************************************************
  248.  *                Function prototypes                                         *
  249.  ******************************************************************************/
  250. void    s_printf(char *,...);       /* High level variable sio puts           */
  251.  
  252. /*  COMMENT
  253.    Copy this function to your door source code to create the s_printf() func.
  254.    See ckitdemo.c. Default buffer is 82 chars, modify as  needed.
  255.  
  256. void s_printf(char *s_format,...) {
  257.     va_list arg_pointer;
  258.     char buffer[82];
  259.     va_start(arg_pointer, s_format);
  260.     vsprintf(buffer, s_format, arg_pointer);
  261.     s_puts(buffer);
  262.     va_end(arg_pointer);
  263. }
  264.  
  265. */
  266.  
  267. /******************************************************************************
  268.  *                External function prototypes                                *
  269.  ******************************************************************************/
  270.  
  271. extern  void    ck_clear_screen(void);
  272. extern  void    ck_set_r_c(short, short);
  273. extern  short   ck_open_door(char *, ...);
  274. extern  void    ck_close_door(void);
  275. extern  void    ck_s_putv();                   /* High level send variable string I/O function     */
  276. extern  void    ck_s_puts(char *);             /* High level send string I/O function              */
  277. extern  void    ck_s_putsn(char *);            /* High level send string LOCAL only                */
  278. extern  void    ck_s_putstd(char *);           /* High level send string using STD output          */
  279. extern  void    ck_s_putc(BYTE);               /* High level send char.  I/O function              */
  280. extern  void    ck_newline(void);              /* send a Carriage return, line feed                */
  281. extern  void    ck_clear_row(short);           /* Clear a given row of screen                      */
  282. extern  void    ck_color(short);               /* Select ANSI color to use                         */
  283. extern  void    ck_pos_cursor(short, short);   /* Position cursor using ANSI                       */
  284. extern  void    ck_clr_screen(void);           /* Clear local/remote screens                       */
  285. extern  void    ck_back_space(short);          /* Destructive backspace  local/remote              */
  286. extern  void    ck_clear_eol(void);            /* Clear to end of line local/remote                */
  287. extern  short   ck_display_file(char *);       /* Display file local/remote                        */
  288. extern  void    ck_prompt_def(char *, char *); /* Display prompt, with default string              */
  289. extern  void    ck_get_def(char *, char *);    /* Same as prompt_def, but gets input               */
  290. extern  void    ck_get_defn(char *, char *);   /* Same as get_def, appends "(Enter)=none?"                 */
  291. extern  void    ck_get_defen(char *);          /* Same as get_def, but default is always "(Enter=none? "   */
  292. extern  void    ck_get_defyn(char *, short);   /* Get input with yes/no default based on short value       */
  293. extern  short   ck_nomore(void);               /* prompt more?, returns TRUE if no or              */
  294. extern  short   ck_inkey(void);                /* Read char. from local/remote                     */
  295. extern  short   ck_getkey(void);               /* Read char. from local keyboard                   */
  296. extern  short   ck_wait_keypress(void);        /* Waits for any key press, high level              */
  297. extern  void    ck_force_enter(void);          /* Force user to press enter key to continue        */
  298. extern  void    ck_get_cmdline(void);
  299. extern  void    ck_get_cmdline_raw(short);     /* Get cmdline, erase prompt based on short         */
  300. extern  void    ck_input(BYTE *, short);       /* Read input into cmdline, local/remote            */
  301. extern  short   ck_keystat();                  /* Check if key waiting                             */
  302. extern  BYTE    ck_receive(void);              /* Get character receieved from the receive buffer  */
  303. extern  BYTE    ck_sio_getbyte (void);         /* Returns byte from port, if available             */
  304. extern  char    ck_get_nextpar(void);
  305. extern  void    ck_check_time_left(void);  /* Check if user time is up, sets DUMPUSER              */
  306. extern  short   ck_mins_left_system(void); /* Returns number of minutes left on system */
  307. extern  short   ck_system_time_used(void); /* Returns mins since door was opened */
  308. extern  void    ck_adjust_time_allowed(short); /* Add/Subtract user time left                      */
  309. extern  short   ck_check_event(void);      /* Check if time left conflicts with event              */
  310. extern  short   ck_mins_before_event(void);/* Return minutes left before event                     */
  311. extern  short   ck_event_minutes(void);    /* Return minutes from midnight of event                */
  312. extern  void    ck_lower_dtr(void);        /* Lower DTR line on serial port                        */
  313. extern  void    ck_raise_dtr(void);        /* Raise DTR line on serial port                        */
  314. extern  void    ck_force_offhook(void);    /* Force modem to hangup, go offhook                    */
  315. extern  BYTE    ck_check_cd(void);         /* Return CARRIER status, Non-Zero = CARRIER            */
  316. extern  void    ck_transmit_data(char *);  /* Xmit to remote only, with CARRIER detect             */
  317. extern  short   ck_transmit_modem(char *); /* Xmit to modem, WITHOUT CARRIER detect                */
  318. extern  short   ck_tqueue_len(void);       /* Returns length (in bytes) of serial xmit buffer      */
  319. extern  BYTE *  ck_flush_rqueue(void);     /* Flush serial input buffer        */
  320. extern  void    ck_wait(short);            /* Wait delay in seconds            */
  321. extern  short   ck_check_CR(void);         /* Check for Carriage Return, TRUE/FALSE */
  322. extern  short   ck_check_keypress(BYTE);   /* Check for any ASCII code press   */
  323. extern  short   ck_r_count(void);          /* Return number bytes in rqueue    */
  324. extern  void    ck_purge_buffer(BYTE *, short); /* Purge buffer to NULLS       */
  325. extern  void    ck_debug_on(void);         /* Disable keyboard timer, carrier  */
  326. extern  void    ck_debug_off(void);        /* Disable keyboard timer, carrier  */
  327. extern  void    ck_carrier_off(void);      /* Same as debug on                 */
  328. extern  void    ck_carrier_on(void);       /* Same as debug off                */
  329. extern  short   ck_dos_shell(char *, char *);  /* Execute external program     */
  330. extern  void    ck_shell_entry(void);          /* Prepare for a DOS shell      */
  331. extern  void    ck_shell_exit(void);           /* Cleanup after a DOS shell    */
  332. extern  void    ck_set_r_c(short, short);  /* Position cursor on local console */
  333. extern  short   ck_update_user();          /* Update user record               */
  334. extern  short   ck_check_CTRL_K(void);     /* Check for CTRL-K press           */
  335. extern  void    ck_CtrlK_ON(void);         /* Enable CTRL-K checking (default) */
  336. extern  void    ck_CtrlK_OFF(void);        /* Disable CTRL-K checking          */
  337. extern  void    ck_set_kybd_time(BYTE, BYTE); /* Set keyboard timeouts         */
  338. extern  short   ck_set_ANSI(short);           /* Turn on ANSI compability      */
  339.  
  340.  
  341. /****************************************************************************
  342.  *      IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF IF         *
  343.  ****************************************************************************/
  344. /* Turbo C has a delay() function and does the same thing.                  */
  345. #if COMPILER == MICROSOFT           /* Use Ckit's delay if not using TURBOC */
  346.  
  347. extern  void    ck_delay(short);    /* Gen. Purpose delay X 55 milliseconds */
  348.  
  349. #endif
  350.  
  351. /****************************************************************************
  352.  *     ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF ENDIF    *
  353.  ****************************************************************************/
  354. #ifdef __cplusplus
  355. }
  356. #endif
  357.  
  358.  
  359. #endif  /* __CKIT_H */
  360.  
  361. /******************************************************************************
  362.  ************************ E N D  OF  M O D U L E ******************************/
  363.